List Attachments
AutomatR.DocuSign.Activities.ListAttachments
The "List Attachments" activity in AutomatR is part of the DocuSign Attachments package, providing the functionality to retrieve all attachments associated with a specific envelope in DocuSign. This activity facilitates efficient management of attachments within DocuSign-enveloped workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Envelope ID | Enter the Envelope ID to identify the DocuSign envelope for which attachments need to be retrieved. This field supports only Strings or String variables. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "List Attachments" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Output | |
| Response | Returns all the attachments associated with the specified envelope in the form of an EnvelopeAttachmentsResult object. Variables of data type EnvelopeAttachmentsResult to store the attachment details. |
How to use:
- Drag and drop the "List Attachments" activity onto the workflow.
- Configure the properties by specifying the Envelope ID and optionally, the Delay.
- Execute the workflow to retrieve information about attachments associated with the specified envelope.
Important Note:
- Ensure that the "List Attachments" activity is used within the scope of the "DocuSign Scope" activity.
Example: Consider an example where the "List Attachments" activity is used to retrieve all attachments associated with an envelope:
List Attachments:
Delay: 5
Envelope ID: "env123"
Response: attachmentsInfo
In this example, the activity waits for 5 seconds (as specified in the Delay property) and then retrieves information about all attachments associated with the envelope having ID "env123." The details of the attachments are stored in the variable "attachmentsInfo" for further processing in the workflow.